DHSI 2021 Presentation: Introduction to Github

John D. Muccigrosso

Friday, 27 May 2022

GitHub

Say hello to Octocat

And hold on a minute

Let’s talk about text

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Plaintext

You should be using plain old text more.

Plaintext

Why?

  1. It lasts
  2. Files are small
  3. 👀 You can read it yourself
  4. You don’t need expensive software to work on it
  5. There are standard data formats for lots of uses
  6. There are tools (edit, display, count, process)
  7. You won’t waste time playing with Comic Sans

Some tools

  • BBEdit (for Macs) - text editor
  • LaTeX - for complex formatting of documents (like math papers)
  • markdown - remarkably competent mark-up language for word-processing
  • pandoc - converts from plaintext to multiple formats like PDF, Word, PowerPoint

Some tools

Some Examples: JSON

Testing

Some Examples: MS Office

> unzip -l Mellon-Arts-and-the-Common-Good-Faculty-Mentored-Student-Research-Grant.docx
Archive:  Mellon-Arts-and-the-Common-Good-Faculty-Mentored-Student-Research-Grant.docx
  Length      Date    Time    Name
---------  ---------- -----   ----
     2119  01-01-1980 00:00   [Content_Types].xml
      735  01-01-1980 00:00   _rels/.rels
     1766  01-01-1980 00:00   word/_rels/document.xml.rels
    27166  01-01-1980 00:00   word/document.xml
     1384  01-01-1980 00:00   word/footer1.xml
     1384  01-01-1980 00:00   word/header2.xml
     1384  01-01-1980 00:00   word/header1.xml
     1384  01-01-1980 00:00   word/footer2.xml
   121940  01-01-1980 00:00   docProps/thumbnail.jpeg
     7643  01-01-1980 00:00   word/theme/theme1.xml
     2353  01-01-1980 00:00   word/settings.xml
    16445  01-01-1980 00:00   word/stylesWithEffects.xml
    15579  01-01-1980 00:00   word/styles.xml
      737  01-01-1980 00:00   docProps/app.xml
     2962  01-01-1980 00:00   word/fontTable.xml
     6651  01-01-1980 00:00   word/numbering.xml
      431  01-01-1980 00:00   word/webSettings.xml
      745  01-01-1980 00:00   docProps/core.xml
---------                     -------
   212808                     18 files

Some Examples: MS Office

Some Examples: MS Office

Back to GitHub

Not a how-to, but a what-is

Origins

  • Based on git, a version-control system (2005)
    • For programmers originally
  • Website github.com uses git, but adds lots of goodies
  • Bought by MicroSoft
Krd (photo)Von Sprat (crop/extraction), CC BY-SA 3.0 https://creativecommons.org/licenses/by-sa/3.0, via Wikimedia Commons

Basic concepts

Repo

Managing your repo

Forking a repo

Handle teams

https://dzone.com/articles/git-vs-github-demystifying-the-differences

Workflow

Other stuff

Some examples

More examples

Some resources

Your data

Think about what you’re doing with your data

  • Is it available to others?
  • If so, what kind of license are you putting on it?
  • You can publish it via GitHub or at sites like Zenodo

Time for questions